<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ZipHelper (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ZipHelper (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ZipHelper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipContentTypeManager.html" title="class in org.apache.poi.openxml4j.opc.internal"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/openxml4j/opc/internal/ZipHelper.html" target="_top">FRAMES</a></li>
<li><a href="ZipHelper.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.openxml4j.opc.internal</p>
<h2 title="Class ZipHelper" class="title">Class ZipHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.openxml4j.opc.internal.ZipHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <strong>ZipHelper</strong>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#READ_WRITE_FILE_BUFFER_SIZE">READ_WRITE_FILE_BUFFER_SIZE</a></strong></code>
<div class="block">Buffer to read data from file.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.zip.ZipEntry</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#getContentTypeZipEntry(org.apache.poi.openxml4j.opc.ZipPackage)">getContentTypeZipEntry</a></strong>(<a href="../../../../../../org/apache/poi/openxml4j/opc/ZipPackage.html" title="class in org.apache.poi.openxml4j.opc">ZipPackage</a>&nbsp;pkg)</code>
<div class="block">Retrieve the Zip entry of the content types part.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.zip.ZipEntry</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#getCorePropertiesZipEntry(org.apache.poi.openxml4j.opc.ZipPackage)">getCorePropertiesZipEntry</a></strong>(<a href="../../../../../../org/apache/poi/openxml4j/opc/ZipPackage.html" title="class in org.apache.poi.openxml4j.opc">ZipPackage</a>&nbsp;pkg)</code>
<div class="block">Retrieve the zip entry of the core properties part.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#getOPCNameFromZipItemName(java.lang.String)">getOPCNameFromZipItemName</a></strong>(java.lang.String&nbsp;zipItemName)</code>
<div class="block">Convert a zip name into an OPC name by adding a leading forward slash to
 the specified item name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#getZipItemNameFromOPCName(java.lang.String)">getZipItemNameFromOPCName</a></strong>(java.lang.String&nbsp;opcItemName)</code>
<div class="block">Convert an OPC item name into a zip item name by removing any leading
 forward slash if it exist.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.net.URI</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#getZipURIFromOPCName(java.lang.String)">getZipURIFromOPCName</a></strong>(java.lang.String&nbsp;opcItemName)</code>
<div class="block">Convert an OPC item name into a zip URI by removing any leading forward
 slash if it exist.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.zip.ZipFile</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#openZipFile(java.io.File)">openZipFile</a></strong>(java.io.File&nbsp;file)</code>
<div class="block">Opens the specified file as a zip, or returns null if no such file exists</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.zip.ZipFile</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipHelper.html#openZipFile(java.lang.String)">openZipFile</a></strong>(java.lang.String&nbsp;path)</code>
<div class="block">Retrieve and open a zip file with the specified path.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="READ_WRITE_FILE_BUFFER_SIZE">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>READ_WRITE_FILE_BUFFER_SIZE</h4>
<pre>public static final&nbsp;int READ_WRITE_FILE_BUFFER_SIZE</pre>
<div class="block">Buffer to read data from file. Use big buffer to improve performaces. the
 InputStream class is reading only 8192 bytes per read call (default value
 set by sun)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.openxml4j.opc.internal.ZipHelper.READ_WRITE_FILE_BUFFER_SIZE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getCorePropertiesZipEntry(org.apache.poi.openxml4j.opc.ZipPackage)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorePropertiesZipEntry</h4>
<pre>public static&nbsp;java.util.zip.ZipEntry&nbsp;getCorePropertiesZipEntry(<a href="../../../../../../org/apache/poi/openxml4j/opc/ZipPackage.html" title="class in org.apache.poi.openxml4j.opc">ZipPackage</a>&nbsp;pkg)</pre>
<div class="block">Retrieve the zip entry of the core properties part.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/poi/openxml4j/exceptions/OpenXML4JException.html" title="class in org.apache.poi.openxml4j.exceptions">OpenXML4JException</a></code> - Throws if internal error occurs.</dd></dl>
</li>
</ul>
<a name="getContentTypeZipEntry(org.apache.poi.openxml4j.opc.ZipPackage)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentTypeZipEntry</h4>
<pre>public static&nbsp;java.util.zip.ZipEntry&nbsp;getContentTypeZipEntry(<a href="../../../../../../org/apache/poi/openxml4j/opc/ZipPackage.html" title="class in org.apache.poi.openxml4j.opc">ZipPackage</a>&nbsp;pkg)</pre>
<div class="block">Retrieve the Zip entry of the content types part.</div>
</li>
</ul>
<a name="getOPCNameFromZipItemName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOPCNameFromZipItemName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getOPCNameFromZipItemName(java.lang.String&nbsp;zipItemName)</pre>
<div class="block">Convert a zip name into an OPC name by adding a leading forward slash to
 the specified item name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>zipItemName</code> - Zip item name to convert.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An OPC compliant name.</dd></dl>
</li>
</ul>
<a name="getZipItemNameFromOPCName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZipItemNameFromOPCName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getZipItemNameFromOPCName(java.lang.String&nbsp;opcItemName)</pre>
<div class="block">Convert an OPC item name into a zip item name by removing any leading
 forward slash if it exist.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opcItemName</code> - The OPC item name to convert.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A zip item name without any leading slashes.</dd></dl>
</li>
</ul>
<a name="getZipURIFromOPCName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZipURIFromOPCName</h4>
<pre>public static&nbsp;java.net.URI&nbsp;getZipURIFromOPCName(java.lang.String&nbsp;opcItemName)</pre>
<div class="block">Convert an OPC item name into a zip URI by removing any leading forward
 slash if it exist.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opcItemName</code> - The OPC item name to convert.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A zip URI without any leading slashes.</dd></dl>
</li>
</ul>
<a name="openZipFile(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openZipFile</h4>
<pre>public static&nbsp;java.util.zip.ZipFile&nbsp;openZipFile(java.io.File&nbsp;file)
                                         throws java.io.IOException</pre>
<div class="block">Opens the specified file as a zip, or returns null if no such file exists</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The file to open.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The zip archive freshly open.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="openZipFile(java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>openZipFile</h4>
<pre>public static&nbsp;java.util.zip.ZipFile&nbsp;openZipFile(java.lang.String&nbsp;path)
                                         throws java.io.IOException</pre>
<div class="block">Retrieve and open a zip file with the specified path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The file path.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The zip archive freshly open.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ZipHelper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/openxml4j/opc/internal/ZipContentTypeManager.html" title="class in org.apache.poi.openxml4j.opc.internal"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/openxml4j/opc/internal/ZipHelper.html" target="_top">FRAMES</a></li>
<li><a href="ZipHelper.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
